/// @copyright
/// Copyright (C) 2020 Assured Information Security, Inc.
///
/// @copyright
/// Permission is hereby granted, free of charge, to any person obtaining a copy
/// of this software and associated documentation files (the "Software"), to deal
/// in the Software without restriction, including without limitation the rights
/// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
/// copies of the Software, and to permit persons to whom the Software is
/// furnished to do so, subject to the following conditions:
///
/// @copyright
/// The above copyright notice and this permission notice shall be included in
/// all copies or substantial portions of the Software.
///
/// @copyright
/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
/// SOFTWARE.

#ifndef MOCKS_VMMCTL_MAIN_HPP
#define MOCKS_VMMCTL_MAIN_HPP

#include <ioctl_t.hpp>

#include <bsl/arguments.hpp>
#include <bsl/discard.hpp>
#include <bsl/errc_type.hpp>

namespace vmmctl
{
    /// <!-- description -->
    ///   @brief Provides the main implementation of the vmmctl application.
    ///     This application is used to start and stop the VMM as well as
    ///     to dump the contents of the VMM's internal debug ring to the
    ///     console for debugging.
    ///
    class vmmctl_main final
    {
    public:
        /// <!-- description -->
        ///   @brief Process the user provided command line arguments.
        ///     If the user provided command succeeds, this function
        ///     will return bsl::errc_success, otherwise this function
        ///     will return bsl::errc_failure.
        ///
        /// <!-- inputs/outputs -->
        ///   @param mut_args the command line arguments provided by the user.
        ///   @param ioctl the ioctl_t to use
        ///   @return If the user provided command succeeds, this function
        ///     will return bsl::errc_success, otherwise this function
        ///     will return bsl::errc_failure.
        ///
        [[nodiscard]] static constexpr auto
        process(bsl::arguments &mut_args, ioctl_t const &ioctl) noexcept -> bsl::errc_type
        {
            bsl::discard(ioctl);

            if (mut_args.get<bool>("fail")) {
                return bsl::errc_failure;
            }

            return bsl::errc_success;
        }
    };
}

#endif
